// --------------------------------------------------------------------------------------------------------------------
// <copyright file="SimpleAgentMessage.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Runtime
{
    using System.Runtime.Serialization;

    /// <summary>
    /// Container class that can be used to wrap an existing state class or struct that doesn't derive from AgentState
    /// </summary>
    /// <typeparam name="T">The wrapped state type.</typeparam>
    [DataContract]
    public class SimpleAgentMessage<T> : AgentMessage
    {
        /// <summary>
        /// The wrapped state.
        /// </summary>
        [DataMember]
        private T state;

        /// <summary>
        /// Initializes a new instance of the SimpleAgentMessage class.
        /// This constructor is intended for Consumer/Producer agents.
        /// </summary>
        /// <param name="state">The instance to wrap.</param>
        /// <param name="initiatingMessage">
        /// The lower-level message that triggered the creation of this message (e.g. a HorizontalDepthProfileMessage is created as a result of a DepthMessage).
        /// The constructor copies the originatingTime from the initiatingMessage to this message, to allow synchronization of messages that have the same real-world origin.
        /// </param>
        public SimpleAgentMessage(T state, AgentMessage initiatingMessage)
            : base(initiatingMessage)
        {
            this.state = state;
        }

        /// <summary>
        /// Initializes a new instance of the SimpleAgentMessage class. 
        /// This constructor is intended for Producer-only agents.
        /// </summary>
        /// <param name="state">The instance to wrap.</param>
        /// <param name="originatingTime">The time, in ms, when the underlying data coming from hardware was generated.</param>
        public SimpleAgentMessage(T state, long originatingTime)
            : base(originatingTime)
        {
            this.state = state;
        }

        /// <summary>
        /// Gets the contained state object. 
        /// </summary>
        public T State
        {
            get
            {
                return this.state;
            }
        }
    }
}
